FUNCTION

 

Description

Calls a pre-defined function and returns a value.  The available pre-defined functions are listed below.

 

FUNCTION Element/Attribute Table

TYPE = FUNCTION

Element

Attributes

Attribute Value

Element Value

<MathVariable>

TYPE

FUNCTION

Call to a function in the form of: FunctionName(Parameters).

 

DATATYPE

Needs to match the data type of the return value.

 

 

XML Example

<MathVariable VARIABLENAME="NewDate" TYPE="FUNCTION" DATATYPE="DATE">ToDate(SystemDateMV, DayMV)</MathVariable>

 

Available Functions

Signature

Description

Return Value

ANBAgeOf( Date, Date )

Computes the age in years given two dates.

INTEGER

ToDate( Date )

Returns the given date.

DATE

ToDate( object )

Converts the given value to a date.

DATE

ToDate( string )

Converts the given value to a date.

DATE

ToDecimal( double )

Converts the given value to a double value.

DOUBLE

ToDecimal( int )

Converts the given value to a double value.

DOUBLE

ToDecimal( object )

Converts the given value to a double value.

DOUBLE

ToDecimal( string )

Converts the given value to a double value.

DOUBLE

ToInteger( double )

Converts the given value to an integer.

INTEGER

ToInteger( int )

Returns the given integer.

INTEGER

ToInteger( object )

Converts the given value to an integer.

INTEGER

ToInteger( string )

Converts the given value to an integer.

INTEGER

ToText( Date )

Converts the given value to a text.

TEXT

ToText( double )

Converts the given value to a text.

TEXT

ToText( int )

Converts the given value to a text.

TEXT

ToText( object )

Converts the given value to a text.

TEXT

ToText( string )

Converts the given value to a text.

TEXT

CalendarMonthsDiffOf( Date, Date )

Computes the number of months between two dates.

DATE

CalendarQuarter( Date )

Returns the end date of the quarter that contains the given date.

DATE

CalendarYearsDiffOf( Date, Date )

Computes the number of years between two dates.

INTEGER

DayOf( Date )

Returns the day portion of the given date.

INTEGER

DaysAdd( Date, int )

Adds a number of days to a date.

DATE

DaysDiffOf( Date, Date )

Computes the number of days between two dates.

INTEGER

DurationOf( Date, Date )

Alias for AgeOf().

INTEGER

FullMonthsDiffOf( Date, Date )

Computes the number of months between two dates.

INTEGER

GivesBestDay( Date, int )

Computes a date having the same month and year as the given date and with the specified day of the month. If the specified day causes the new date to roll over into the next month, the day is decreased until that does not occur.

DATE

MaxDateOf( Date, Date )

Returns the greater of two dates.

DATE

MinDateOf( Date, Date )

Returns the lesser of two dates.

DATE

MonthOf( Date )

Returns the month portion of the given date.

INTEGER

MonthsAdd( Date, int )

Adds a number of months to a date.

DATE

MonthsDiffOf( Date, Date )

Computes the number of months between two dates.

INTEGER

NextMultipleMode( Date, int, int )

Returns a date that is a number of units from the StartDate.

DATE

PolMonthOf( Date, Date )

Computes the month number of (a policy) at a specified point in time.

INTEGER

QuartersAdd( Date, int )

Adds a number of quarters (3 months) to a date.

DATE

ReplaceDayOfMonth( Date, int )

Replaces the day portion of a date.

DATE

ReplaceMonth( Date, int )

Replaces the month portion of a date.

DATE

ReplaceYear( Date, int )

Replaces the year portion of a date.

DATE

YearBeginOf( Date )

Determines the first day of the year of the given date.

DATE

YearsDiffOf( Date, Date )

Computes the number of years between two dates.

INTEGER

AbsOf( double )

Returns the absolute value of the given value.

DOUBLE

AbsOf( int )

Returns the absolute value of the given value.

INTEGER

MaxOf( double, double )

Returns the larger of two numbers.

DOUBLE

MaxOf( double, int )

Returns the larger of two numbers.

DOUBLE

MaxOf( int, double )

Returns the larger of two numbers.

DOUBLE

MaxOf( int, int )

Returns the larger of two numbers.

INTEGER

MinOf( double, double )

Returns the Minimum result of comparing two numbers.

DOUBLE

MinOf( double, int )

Returns the Minimum result of comparing two numbers.

DOUBLE

MinOf( int, double )

Returns the Minimum result of comparing two numbers.

DOUBLE

MinOf( int, int )

Returns the Minimum result of comparing two numbers.

INTEGER

PresentValue( double, int, double, double, double )

Calculates the present value of a number.

DOUBLE

TruncateNumber( double, int )

Truncates number.

DOUBLE

IsEmpty( Date )

Returns True if variable has not been initialized.

BOOLEAN

IsEmpty( object )

Returns True if variable has not been initialized.

BOOLEAN

IsEmpty( string )

Returns True if variable has not been initialized.

BOOLEAN

TableMult( string )

Determines the rate multiplier for the given table rating code.

DATE

IsAlpha( string )

Returns True if string is alphabetic.

BOOLEAN

IsAlphaNumeric( string )

Returns True if string is alphanumeric.

BOOLEAN

IsNumeric( string )

Returns True if string is numeric.

BOOLEAN

IsDate( Object )

Returns True if the object passed is a valid date object or a text value containing a valid date string.

BOOLEAN

IsLeapYearByYear( Integer )

Returns True if the number passed in is a year in which February has 29 days.

BOOLEAN

ToDecimalArray( Object )

Casts the object passed in as an array of DECIMALs. Throws an error if the object cannot be cast.

DECIMAL

ToIntegerArray( Object )

Casts the object passed in as an array of INTEGERSs. Throws an error if the object cannot be cast.

INTEGER

ToObject( Object )

Returns the given object of any type as an OBJECT.

OBJECT

ToTextArray( Object )

Casts the object passed in as an array of TEXT values. Throws an error if the object cannot be cast.

TEXT

YearEndOf( Date )

Determines the last day of the year of the given date. Parameter is a date. Return is the last day of the year.

DATE

YearOf( Date )

Returns the year portion of the given date. Parameter is a date. Return is the year portion of date.

DATE

YearsAdd( Date, Integer )

Adds a number of years to a date. If years is negative, the resulting date will be before the given date. Parameters are a given date and the number of years to add. Return is the new date.

DATE